Get a specific timeperiod

GET 
/timestreams/:timestreamId/timelines/:timelineId/periods/:timeperiodId

Get full details for a specific period for a specific timeline under a specific timestream

Request

Path Parameters

timestreamId stringrequired
timelineId stringrequired
timeperiodId stringrequired

Header Parameters

x-api-key passwordrequired

OneBasket API Key

Responses

200

The request has succeeded.

application/json

Schema

Schema

anyOf

Timeperiods.PrimaryPeriodDto

type stringrequired

Possible values: [Primary]

The type of the timeline

type stringrequired

Possible values: [Primary, Collection, ProductAvailability]

Discriminator for timeline types

Primary

circular(Timeperiods.PrimaryPeriodDto)

Collection

type stringrequired

Possible values: [Collection]

The type of the timeline

capacity integerrequired

The capacity that can be served in this timeperiod

ProductAvailability

type stringrequired

Possible values: [ProductAvailability]

The type of the timeline

productAvailabilityGroup stringrequired

The availability group for this period

id stringrequired

The unique identifier of the timeperiod

timestreamId stringrequired

The unique identifier of the parent timestream

timelineId stringrequired

The unique identifier of the parent timeline

title stringrequired

The title of the timeperiod

description stringrequired

The description of the timeperiod

start date-timerequired

The start time of the timeperiod

duration durationrequired

The duration of the timeperiod

end date-timerequired

The end time of the timeperiod

Timeperiods.CollectionPeriodDto

type stringrequired

Possible values: [Collection]

The type of the timeline

capacity integerrequired

The capacity that can be served in this timeperiod

type stringrequired

Possible values: [Primary, Collection, ProductAvailability]

Discriminator for timeline types

Primary

type stringrequired

Possible values: [Primary]

The type of the timeline

Collection

circular(Timeperiods.CollectionPeriodDto)

ProductAvailability

type stringrequired

Possible values: [ProductAvailability]

The type of the timeline

productAvailabilityGroup stringrequired

The availability group for this period

id stringrequired

The unique identifier of the timeperiod

timestreamId stringrequired

The unique identifier of the parent timestream

timelineId stringrequired

The unique identifier of the parent timeline

title stringrequired

The title of the timeperiod

description stringrequired

The description of the timeperiod

start date-timerequired

The start time of the timeperiod

duration durationrequired

The duration of the timeperiod

end date-timerequired

The end time of the timeperiod

Timeperiods.ProductAvailabilityPeriodDto

type stringrequired

Possible values: [ProductAvailability]

The type of the timeline

productAvailabilityGroup stringrequired

The availability group for this period

type stringrequired

Possible values: [Primary, Collection, ProductAvailability]

Discriminator for timeline types

Primary

type stringrequired

Possible values: [Primary]

The type of the timeline

Collection

type stringrequired

Possible values: [Collection]

The type of the timeline

capacity integerrequired

The capacity that can be served in this timeperiod

ProductAvailability

circular(Timeperiods.ProductAvailabilityPeriodDto)

id stringrequired

The unique identifier of the timeperiod

timestreamId stringrequired

The unique identifier of the parent timestream

timelineId stringrequired

The unique identifier of the parent timeline

title stringrequired

The title of the timeperiod

description stringrequired

The description of the timeperiod

start date-timerequired

The start time of the timeperiod

duration durationrequired

The duration of the timeperiod

end date-timerequired

The end time of the timeperiod

Example (from schema)

{}

400

The server could not understand the request due to invalid syntax.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Bad request]

A short, human-readable summary of the problem type.

status number

Possible values: [400]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

errors objectrequired
property name* object

Example (from schema)

{
  "type": "string",
  "title": "Bad request",
  "status": 400,
  "detail": "string",
  "instance": "string",
  "errors": {}
}

401

Access is unauthorized.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Unauthorized]

A short, human-readable summary of the problem type.

status number

Possible values: [401]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Unauthorized",
  "status": 401,
  "detail": "string",
  "instance": "string"
}

404

The server cannot find the requested resource.

application/json

Schema

Schema

type string

A URI reference [RFC3986] that identifies the problem type.

title string

Possible values: [Not Found]

A short, human-readable summary of the problem type.

status number

Possible values: [404]

The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.

detail string

A human-readable explanation specific to this occurrence of the problem.

instance string

A URI reference that identifies the specific occurrence of the problem.

Example (from schema)

{
  "type": "string",
  "title": "Not Found",
  "status": 404,
  "detail": "string",
  "instance": "string"
}

Loading...